fun createOnlinePresentationSession( authorizationRequestUri: String, authenticationOption: AuthenticationOption = AuthenticationOption.Signature, requireTrustedVerifier: Boolean = false): OnlinePresentationSession

Create an online presentation session compliant with the ISO 18013-7 and OpenID4VP.

createProximityPresentationSession

suspend fun createProximityPresentationSession( activity: Activity, authenticationOption: AuthenticationOption = AuthenticationOption.Signature, bleMode: BleMode = BleMode.MDocClientCentral, onRequestReceived: ProximityPresentationSession.OnRequestReceived, onConnected: ProximityPresentationSession.OnConnected? = null, onSessionTerminated: ProximityPresentationSession.OnSessionTerminated? = null): ProximityPresentationSession

Create a proximity based presentation session with a mobile credential verifier using device retrieval as per ISO/IEC 18013-5:2021.

deinitialize

suspend fun deinitialize()

Deinitialize the MobileCredentialHolder SDK.

deleteCredential

@Blocking

fun deleteCredential(id: String)

Deletes a mobile credential from storage.

deleteTrustedIssuerCertificate

@Blocking

fun deleteTrustedIssuerCertificate(certificateId: String)

Delete a trusted issuer certificate from storage.

deleteTrustedVerifierCertificate

@Blocking

fun deleteTrustedVerifierCertificate(certificateId: String)

Delete a trusted verifier certificate from storage.

destroy

suspend fun destroy(context: Context, instanceId: String = DEFAULT_INSTANCE_ID)

Destroys an instance of the SDK.

discoverCredentialOffer

suspend fun discoverCredentialOffer(offer: String): DiscoveredCredentialOffer

It is recommended to display the details of DiscoveredCredentialOffer on the app UI before calling the retrieveCredentials function.

generateDeviceKey

suspend fun generateDeviceKey(activity: Activity, popOptions: DeviceKeyPopOptions? = null): GeneratedDeviceKeyResult

Generate a device key for provisioning a new mobile credential.

getCredential

@Blocking

fun getCredential(id: String, skipStatusCheck: Boolean = false): MobileCredential

Retrieve a specific mobile credential from the storage.

getCredentials

@Blocking

fun getCredentials(): List<MobileCredentialMetaData>

Retrieve all mobile credentials' metadata from storage.

getCurrentProximityPresentationSession

fun getCurrentProximityPresentationSession(): ProximityPresentationSession?

Get the current proximity presentation session.

getLog

fun getLog(): String?

Close and return the full address of the current log file.

getTrustedIssuerCertificates

@Blocking

fun getTrustedIssuerCertificates(): List<TrustedCertificate>

Retrieve all trusted issuer certificates from storage.

getTrustedVerifierCertificates

@Blocking

fun getTrustedVerifierCertificates(): List<TrustedCertificate>

Retrieve all trusted verifier certificates from storage.

initialize

suspend fun initialize( activity: Activity, instanceId: String = DEFAULT_INSTANCE_ID, userAuthRequiredOnInitialize: Boolean = true, credentialIssuanceConfiguration: CredentialIssuanceConfiguration? = null, loggerConfiguration: Logger.LoggerConfiguration? = null)

Initialize the MobileCredentialHolder SDK. The MobileCredentialHolder class is a singleton which can only be initialized with one instanceId at a time. After this initialize method has been called, all subsequent method calls in this class, such as getTrustedIssuerCertificates, will return a result unique to the specified instanceId.

retrieveCredentials

suspend fun retrieveCredentials( activity: Activity, credentialOffer: String, clientId: String, transactionCode: String? = null): List<RetrieveCredentialResult>

A failure to retrieve, validate, or save a credential will NOT automatically cause a failure of other credential requests.